core/androidx.core.app/[main]FrameMetricsAggregator

FrameMetricsAggregator

open class FrameMetricsAggregator(source)

This class can be used to record and return data about per-frame durations. It returns those results in an array per metric type, with the results indicating how many samples were recorded for each duration value. The details of the durations data are described in getMetrics.

For more information on the various metrics tracked, see the documentation for the FrameMetrics API added in API 24 as well as the GPU Profiling guide.

Constructors

FrameMetricsAggregator

constructor()

Constructs a FrameMetricsAggregator object that will track TOTAL_DURATION metrics.

constructor(metricTypeFlags: Int)

Constructs a FrameMetricsAggregator object that will track the metrics specified bty metricTypeFlags, which is a value derived by OR'ing together metrics constants such as TOTAL_DURATION to specify all metrics that should be tracked.

Types

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@Retention(value = RetentionPolicy.SOURCE)

annotation class MetricType

Properties

ANIMATION_DURATION

val ANIMATION_DURATION: Int = 256

A flag indicating that the metrics should track the animation duration.

ANIMATION_INDEX

val ANIMATION_INDEX: Int = 8

The index in the metrics array where the data for ANIMATION_DURATION is stored.

COMMAND_DURATION

val COMMAND_DURATION: Int = 32

A flag indicating that the metrics should track the command duration.

val COMMAND_INDEX: Int = 5

The index in the metrics array where the data for SYNC_DURATION is stored.

val DELAY_DURATION: Int = 128

A flag indicating that the metrics should track the delay duration.

val DELAY_INDEX: Int = 7

The index in the metrics array where the data for DELAY_DURATION is stored.

val DRAW_DURATION: Int = 8

A flag indicating that the metrics should track the draw duration.

val DRAW_INDEX: Int = 3

The index in the metrics array where the data for DRAW_DURATION is stored.

val EVERY_DURATION: Int = 511

A flag indicating that the metrics should track all durations.

val INPUT_DURATION: Int = 2

A flag indicating that the metrics should track the input duration.

val INPUT_INDEX: Int = 1

The index in the metrics array where the data for INPUT_DURATION is stored.

LAYOUT_MEASURE_DURATION

val LAYOUT_MEASURE_DURATION: Int = 4

A flag indicating that the metrics should track the layout duration.

LAYOUT_MEASURE_INDEX

val LAYOUT_MEASURE_INDEX: Int = 2

The index in the metrics array where the data for LAYOUT_MEASURE_DURATION is stored.

val SWAP_DURATION: Int = 64

A flag indicating that the metrics should track the swap duration.

val SWAP_INDEX: Int = 6

The index in the metrics array where the data for COMMAND_DURATION is stored.

val SYNC_DURATION: Int = 16

A flag indicating that the metrics should track the sync duration.

val SYNC_INDEX: Int = 4

The index in the metrics array where the data for SYNC_DURATION is stored.

val TOTAL_DURATION: Int = 1

A flag indicating that the metrics should track the total duration.

val TOTAL_INDEX: Int = 0

The index in the metrics array where the data for TOTAL_DURATION is stored.

Functions

open fun add(@NonNull activity: @NonNull Activity)

Starts recording frame metrics for the given activity.

open fun getMetrics(): @Nullable Array<SparseIntArray>

Returns the currently-collected metrics in an array of SparseIntArray objects.

open fun remove(@NonNull activity: @NonNull Activity): @Nullable Array<SparseIntArray>

Stops recording metrics for activity and returns the collected metrics so far.

open fun reset(): @Nullable Array<SparseIntArray>

Resets the metrics data and returns the currently-collected metrics.

open fun stop(): @Nullable Array<SparseIntArray>

Stops recording metrics for all Activities currently being tracked.